home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / doors_2 / wcht201.zip / WILDCHAT.DOC < prev    next >
Text File  |  1992-07-10  |  13KB  |  383 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.  
  13.  
  14.  
  15.  
  16.  
  17.              ┬┬ ┬ ┬ ┬┬ ┬┬─   ─┬┬──┐ ┌┬──┐ ┬┬  ┬ ┌┬──┐ ┌─┬┬─┐ (tm)
  18.              ││ │ │ ││ ││     ││  │ ││    ││  │ ││  │   ││
  19.              ││ │ │ ││ ││     ││  │ ││    │├──┤ │├──┤   ││
  20.              ││ │ │ ││ ││     ││  │ ││    ││  │ ││  │   ││
  21.              └┴─┴─┘ ┴┴ ┴┴──┘ ─┴┴──┘ └┴──┘ ┴┴  ┴ ┴┴  ┴   ┴┴
  22.  
  23.  
  24.                               Version 2.01
  25.  
  26.  
  27.  
  28.  
  29.                                Tim Rider
  30.                              4129 Konya Dr.
  31.                            Torrance, CA 90503
  32.  
  33.  
  34.                      The Source BBS (310) 371-3737
  35.  
  36.  
  37.  
  38.  
  39.        WildChat(tm) is supplied as is.  The author disclaims all
  40.           warranties, expressed or implied, including, without
  41.           limitation, the warranties of merchantability and of
  42.             fitness for any purpose.  The author assumes no
  43.             liability for damages, direct or consequential,
  44.           which may result from the use, or inability to use,
  45.                              WildChat(tm).
  46.  
  47.  
  48.                      (C) Copyright 1992,  Tim Rider
  49.  
  50.  
  51. What is WildChat(tm)?
  52. ═════════════════════
  53.  
  54.   WildChat is a multi-line chat door for the WildCat BBS system.  It is
  55.   designed to replace the internal multi-line chat by using a DOS Hook
  56.   from the main menu.
  57.  
  58.   WildChat(tm) requires BRUN45.EXE, which is not included in this
  59.   archive.
  60.  
  61. Why use it?
  62. ═══════════
  63.  
  64.   WildChat is much faster, and provides many more features than
  65.   WildCat's internal multi-line chat.  WildChat is easier to use,
  66.   and basically, a lot more fun.
  67.  
  68. How does it work?
  69. ═════════════════
  70.  
  71.   WildChat uses the disk to store the messages that users type.  A
  72.   RAM disk is recommended, but not necessary.  A disk cache is
  73.   necessary only if a RAM disk is not used, but still recommended.
  74.  
  75.   WildChat writes to a fixed length file it creates when it is first
  76.   run.  This file is called WILDCHAT.MSG, and it contains the messages
  77.   that users send to each other.  The reason this file is fixed length
  78.   is once again speed.
  79.  
  80.   WildChat writes to another fixed length file called WILDCHAT.DTA. This
  81.   file contains node info data.  This file is used along with WildCat's
  82.   own NODEINFO.DAT to keep track of users on the BBS and in the
  83.   multi-line chat.
  84.  
  85. Other features
  86. ══════════════
  87.  
  88.   Whispering
  89.   ──────────
  90.  
  91.     Whispering is one of those handy features that WildCat's multi-line
  92.     chat just doesn't have.  Normally, messages you type in the multi-
  93.     line chat can be seen by everyone.  WildChat will let you "whisper"
  94.     something to a user privately, so no one else can see your message.
  95.     Let me show you an example.  Let's say there are two users in the
  96.     multi-line chat, T.Rider, and C.North.  You are seeing what T.Rider
  97.     types.
  98.  
  99.       /C.North No one else can see this message!
  100.  
  101.     C.North would see something like this on his screen...
  102.  
  103.       T.Rider (Whispered): No one else can see this message!
  104.  
  105.     It's a handy feature, a must for any conversation!
  106.  
  107.  
  108.   Language Filter
  109.   ───────────────
  110.  
  111.     Naturally, there are always those people who take a liking to words
  112.     that you may not want on your BBS.  If you BBS is a family system,
  113.     then you surely won't want profanity used in the multi-line chat.
  114.     The language filter will screen messages for those words which you
  115.     specify in the file WILDCHAT.BAT.  Read on for more details.
  116.  
  117.   Action Commands
  118.   ───────────────
  119.  
  120.     Action Commands are another of the great features of WildChat that
  121.     WildCat's internal multi-line chat doesn't have.  Action Commands
  122.     are key-words that are linked to a phrase.  I'll give you an
  123.     example, since it is kind of hard to explain.  Once again, T.Rider
  124.     and C.North are in the multi-line chat.  We see what T.Rider
  125.     types...
  126.  
  127.       LAUGH C.North
  128.  
  129.     Everyone in the chat door would see this...
  130.  
  131.       T.Rider is laughing at C.North!
  132.  
  133.     Or this...
  134.  
  135.       LAUGH
  136.  
  137.     And they would see...
  138.  
  139.       T.Rider is laughing out loud!
  140.  
  141.     instead of seeing "T.Rider: LAUGH C.North".  This adds a lot of
  142.     realism to the multi-line chat, and is another must have feature.
  143.     Read on for more details on how to add and edit action commands.
  144.  
  145.   Help Screens
  146.   ────────────
  147.  
  148.     WildChat uses two external help screens, they are:
  149.  
  150.       CFGHELP.BBS
  151.       MAINHELP.BBS
  152.  
  153.     Of course, example screens have been included, but they aren't very
  154.     good, and I hope to improve them some time.  Feel free to edit these
  155.     screens to your liking.
  156.  
  157.  
  158. Files In This Archive
  159. ═════════════════════
  160.  
  161.   Make sure that you have all of these files, and that they are the
  162.   proper file sizes, etc...
  163.  
  164.   WILDCHAT BAD        50 07-10-92  10:00p
  165.   CFGHELP  BBS      3891 07-10-92  10:00p
  166.   MAINHELP BBS      3525 07-10-92  10:00p
  167.   WILDCHAT CFG      2519 07-10-92  10:00p
  168.   WILDCHAT DAT     18060 07-10-92  10:00p
  169.   WILDCHAT EXE     42907 07-10-92  10:00p
  170.   WILDCHAT LST       927 07-10-92  10:00p
  171.  
  172.  
  173. Installation
  174. ════════════
  175.  
  176.   Make sure ALL nodes are taken down, and that the system is not running
  177.   under a multi-tasker before starting this set up.  Also, ALWAYS BACK
  178.   YOUR SYSTEM UP!
  179.  
  180.  
  181.     1. Make a sub-directory off of the WildCat root directory for WildChat.
  182.        EXAMPLE: C:\WC30\WILDCHAT\
  183.  
  184.     2. Move WILDCHAT.EXE, WILDCHAT.DAT, WILDCHAT.BAD, WILDCHAT.LST into
  185.        this directory.
  186.  
  187.     3. Add a command into your CONFIG.SYS or your AUTOEXEC.BAT to create a
  188.        128k RAM Disk on bootup.
  189.  
  190.     4. Edit WILDCHAT.CFG.  Instructions are in the file, and DO NOT remove
  191.        any lines from the file, or your system may suffer a severe disaster.
  192.  
  193.     5. Move the edited WILDCHAT.CFG into the WildCat ROOT directory.
  194.        EXAMPLE: C:\WC30\
  195.  
  196.     6. Find a free Main Menu DOS Hook.
  197.  
  198.     7. Create a batch file to call WildChat.
  199.  
  200.          EXAMPLE    C:\WC30\MAIN1.BAT  (For DOS Hook 1)
  201.  
  202.                     @ECHO OFF
  203.                     C:\WC30\WILDCHAT\WILDCHAT.EXE
  204.  
  205.     8. If your system uses non-standard IRQ or addresses for COM ports,
  206.        then make sure to add the proper environment variables to the
  207.        correct CATx.BAT file.  Variables needed are listed below...
  208.  
  209.          COMBASE  This is the base address of the COM port being used.
  210.          WCIRQID  This is the IRQ of the COM port being used.
  211.          WCHOME   This is the WildCat home directory.
  212.  
  213.          EXAMPLE  SET COMBASE=1016
  214.                   SET WCIRQID=4
  215.                   SET WCHOME=C:\WC30\
  216.  
  217.          NOTE:  COMBASE *MUST* be in decimal.  "03F8" won't work!  You
  218.                 need to use the decimal value, "1016".
  219.  
  220.     9. Use MAKEWILD and do the following...
  221.  
  222.       (a) Change the MAIN MENU "Multi-User Chat" command letter to
  223.           something like "!" or "@", so no one can accidently access
  224.           WildCat's internal chat.
  225.  
  226.       (b) Change the MAIN MENU "Multi-User Chat" command access level
  227.           to 1000, so only the SysOp can access it.
  228.  
  229.  
  230.       (c) Change the MAIN MENU "DOS hook 1" or "DOS hook 2" command
  231.           letter to "T".
  232.  
  233.       (d) Change the MAIN MENU "DOS hook 1" or "DOS hook 2" command
  234.           access level to a level so that users can access it.
  235.  
  236.       (e) Change the MAIN MENU "DOS hook 1" or "DOS hook 2" command
  237.           description to "[T]..Talk with other Node(s)" or something
  238.           like that.
  239.  
  240.       (f) Go to the DOOR DEFINITION area of MAKEWILD, and change the
  241.           "DOS hook 1" or "DOS hook 2" multi-user flag to YES.
  242.  
  243.    10. Use the WCTEXT.DAT editor to change the following prompts...
  244.  
  245.        NOTE: Prompt numbers are for WildCat 3.5 beta.
  246.  
  247.          #252   from @SUB@ is PAGING.
  248.  
  249.        change the above prompts to...
  250.  
  251.          #252   is PAGING you from WildChat.
  252.  
  253.    11. Load one node of WildCat and give WildChat a try in local mode.
  254.        If there's any problem, review the setup for any mistakes, and
  255.        if the problem cannot be resolved, contact me through The Source
  256.        BBS.
  257.  
  258.  
  259. WildChat(tm) Files  <-- MUST, MUST, MUST READ!
  260. ══════════════════
  261.  
  262.   WildChat(tm) uses several data files, this is an explanation of what they
  263.   are and how to maintain them.
  264.  
  265.  
  266.   Files that WildChat(tm) reads
  267.   ─────────────────────────────
  268.  
  269.     WILDCHAT.CFG  The main configuration file
  270.     WILDCHAT.BAD  The words for the language filter
  271.     WILDCHAT.LST  The action commands
  272.     WILDCHAT.DAT  The prompts and text
  273.     CFGHELP.BBS   User Configuration help screen
  274.     MAINHELP.BBS  Main Commands help screen
  275.     DOOR.SYS      User Info created by WildCat!
  276.  
  277.  
  278.     o WILDCHAT.CFG is a cr/lf format text file.  Use any text editor
  279.       to edit.  If any lines are removed, the door will not run, and
  280.       possible will crash and do unpredictable things.  Please, be
  281.       very careful with this file.  Instructions on which lines are
  282.       which are in the file.
  283.       This is found in the WildCat root directory, which is pointed to
  284.       using the WCHOME environment variable.
  285.  
  286.     o WILDCHAT.BAD is a cr/lf format text file.  Put each word on a
  287.       separate line.  If more than one word is placed on one line, then
  288.       the result may be unpredictable.
  289.       This file is found in the WILDCHAT directory.
  290.  
  291.     o WILDCHAT.LST is a cr/lf format text file.  Each action command
  292.       consists of three lines.
  293.  
  294.         Line #1: COMMAND WORD
  295.         Line #2: TEXT IF COMMAND WORD IS TYPED ALONE
  296.         Line #3: TEXT IF COMMAND WORD IS TYPED WITH AN ADDRESSEE
  297.  
  298.       Here's an example...
  299.  
  300.         Line #1: LAUGH
  301.         Line #2: is laughing out loud!
  302.         Line #3: is laughing at @SUB@!
  303.  
  304.       The code @SUB@ is used to insert the user-ID of the addressee.
  305.  
  306.       This file is found in the WILDCHAT directory.
  307.  
  308.     o WILDCHAT.DAT is the file containing the text that WildChat(tm)
  309.       outputs.  This is the same format as WCTEXT.DAT, and can be edited
  310.       with the WCTEXT.DAT editor that is included with WildCat!  Make
  311.       sure to make a backup before altering this file.
  312.       This file is found in the WILDCHAT directory.
  313.  
  314.  
  315.     o CFGHELP.BBS is a help screen in WildCat 3.0 format.  You can use
  316.       @CLS@, @PAUSE@, and @xx@ color commands.
  317.  
  318.     o MAINHELP.BBS is a help screen in WildCat 3.0 format.  You can use
  319.       @CLS@, @PAUSE@, and @xx@ color commands.
  320.  
  321.     o DOOR.SYS... read the WildCat! manual.
  322.  
  323.   Files that WildChat(tm) creates
  324.   ───────────────────────────────
  325.  
  326.     WILDCHAT.DTA  Contains node information (Who's Online, etc)*
  327.     WILDCHAT.MSG  Contains messages that users type*
  328.     WILDCHAT.USR  Contains user profiles and configuration
  329.     WILDLOG!.???  Contains logging information.  Where ??? is the node #.
  330.  
  331.       * denotes that file is a fixed size
  332.  
  333.     o WILDCHAT.DTA contains information about who is inside WildChat(tm).
  334.       This file should be deleted on every boot-up (if not on a ram disk)
  335.       or any time that WILDCHAT.CFG changes.
  336.       This file is on the RAMDISK.
  337.  
  338. ----> MAKE SURE ALL NODES ARE DOWN BEFORE DELETING OR EDITING ANY
  339.       WILDCHAT(tm) FILES!
  340.  
  341. ----> IF YOU ARE GETTING A "NODE HANDLE IN USE" ERRORS THEN YOU MUST
  342. ----> DELETE WILDCHAT.DTA AND WILDCHAT.MSG.
  343.  
  344.     o WILDCHAT.MSG contains the messages that the users type
  345.       to each other.  This should be treated EXACTLY the way
  346.       WILDCHAT.DTA is treated.
  347.       This file is on the RAMDISK.
  348.  
  349.     o WILDCHAT.USR contains user information and configuration.  This
  350.       file can be deleted, but then users will have to log on new again,
  351.       which is not much of a hassle.  (It may only confuse some users)
  352.       This file is found in the WILDCHAT directory.
  353.  
  354.     o WILDLOG!.??? contains logging information for each node.
  355.       This file should be deleted whenever it gets too large.
  356.       These files are found in the WILDCHAT directory.
  357.  
  358.  
  359. Special Thanks
  360. ══════════════
  361.  
  362.   I'd like to thank the following people for making WildChat possible...
  363.  
  364.     Michael Conley, thanks for all the suggestions, you were a big help!
  365.  
  366.     Tom Tcimpidas, thanks for picking out all the minute details!
  367.  
  368.     Chip North, thanks for running The Source, and for helping me test
  369.                 this thing!
  370.  
  371.     Jeff Sumberg, who wrote QBSerial, the serial communications
  372.                   interface used in WildChat(tm).  Thanks Jeff!  You
  373.                   wrote some GREAT routines!
  374.  
  375.     Lance Stewart, beta tester.
  376.     Hugh Mitchell, beta tester.
  377.     Clayton Manson, beta tester.
  378.  
  379.     Dan Stasinski, honorable mention.  Good guy, great programmer, but
  380.                    I still can't spell his name right.
  381.  
  382.  
  383.